Add coderabbit config and clean up configuration by adamwg · Pull Request #2 · crossplane/cli

adamwg · 2026-05-05T22:10:39Z

Description of your changes

Three small changes to our repository configuration:

Add a coderabbit config based on Crossplane's. We'll get coderabbit running on this repository once this is merged.
Add @jcogilvie and @tampakrap to the CODEOWNERS file.
Stop linting protobufs and pushing them to the Buf schema registry. Our protos are vendored from crossplane/crossplane where they are linted and pushed.

I have:

Read and followed Crossplane's contribution process.
Run ./nix.sh flake check to ensure this PR is ready for review.
~~- [ ] Added or updated unit tests.~~
~~- [ ] Linked a PR or a docs tracking issue to document this change.~~
~~- [ ] Added backport release-x.y labels to auto-backport this PR.~~

Summary by CodeRabbit

Chores
- Updated code review automation configuration
- Removed protobuf schema validation from CI workflow
- Updated code ownership assignments
Documentation
- Updated contributing guidelines with reference to official documentation

Copy Crossplane's coderabbit config as a starting point and remove irrelevant parts. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

jbw976

a couple small comments, thanks @adamwg!

jbw976 · 2026-05-06T00:12:13Z

        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

-      - name: Lint and Push Protocol Buffers
+      - name: Lint Protocol Buffers


i'd argue we don't need to do the protobuf linting - we also copy protobufs from c/c to https://github.com/crossplane/function-sdk-go and we don't lint them there either - so that has precedent 🤔

Yeah, makes sense. Updated.

jbw976 · 2026-05-06T00:13:31Z

+        error testing uses proper patterns (cmpopts.EquateErrors, sentinel
+        errors for complex cases).
+
+    - path: "**/design/**"


i see some patterns that are in c/c but not applicable here - want to take a pass to trim this down to only what's applicable in this repo?

apis/ and test/ I expect will be relevant in the near future, so I left them in. design/ I'm less certain about but figured it was worth keeping in case we introduce design docs here as well.

tampakrap · 2026-05-06T09:33:52Z

I thought it was required by the policy. In any case I'd say to keep it, it allows us also to automatically assign people on PRs and also we might want to match dirs with people in the future

are you referring to the community extension project policies?

just to be clear, the only requirement there is for OWNERS.md, there is no requirement for CODEOWNERS

Updated the CODEOWNERS to include the additional maintainers rather than removing it completely.

This repository has additional maintainers beyond the @crossplane/crossplane-maintainers group. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

The protos in this repository are vendored from crossplane/crossplane, so no need to lint them or push them to the Buf schema registry. This avoids the need for a `BUF_TOKEN` secret in this repo. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

coderabbitai · 2026-05-06T22:34:04Z

Warning

Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories.

📝 Walkthrough

Walkthrough

A comprehensive CodeRabbit review configuration is introduced alongside adjustments to CI workflow, code ownership assignments, and contributing documentation. The protobuf schema linting CI job is removed, and two additional maintainers are added to the default code-owner rule.

Changes

Repository Governance & Review Configuration

Layer / File(s)	Summary
Review Configuration `.coderabbit.yaml`	Introduces a new CodeRabbit configuration defining review language, path-specific review instructions for Go, tests, APIs, CLIs, and docs, pre-merge checks (title length, breaking changes, feature-gate requirements), and disables external tooling checks (buf, golangci-lint, gitleaks, semgrep, yamllint, etc.).
CI Workflow Adjustment `.github/workflows/ci.yml`	Removes the `protobuf-schemas` job that performed protobuf linting via `bufbuild/buf-action`, aligning with CodeRabbit configuration that disables buf-based analysis.
Code Ownership `CODEOWNERS`	Adds two additional maintainers (`jcogilvie` and `tampakrap`) to the default code-owner assignment for all files.
Documentation `CONTRIBUTING.md`	Replaces content with a link to Crossplane's contributing documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 The warren grows with reviewers new,

CodeRabbit hops to check what's true,

Protobuf paths are cleared away,

Config and governance find their way! 🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main changes: adding a coderabbit configuration file and cleaning up configuration files (CODEOWNERS, CI workflow, CONTRIBUTING).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.coderabbit.yaml:
- Around line 170-173: Remove the stray leading double-quote at the start of the
block scalar for the custom check description that begins with "Fails if files
under 'apis/**' or 'cmd/**'..." so the text is a normal YAML block (no literal
leading quote); locate the YAML value containing that sentence and delete the
initial " character so the check instructions read cleanly without the preserved
quote.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 73f5b6c1-4ea8-4859-89ea-e461c0ce4e4e

📥 Commits

Reviewing files that changed from the base of the PR and between f4564b3 and 40224e7.

📒 Files selected for processing (4)

.coderabbit.yaml
.github/workflows/ci.yml
CODEOWNERS
CONTRIBUTING.md

💤 Files with no reviewable changes (1)

.github/workflows/ci.yml

coderabbitai · 2026-05-06T22:35:38Z

+          "Fails if files under 'apis/**' or 'cmd/**' remove or rename public
+          fields/flags, add new required public fields/flags, or remove behavior
+          without label 'breaking-change'.
+


⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove the stray leading quote in custom check instructions.

The block scalar begins with an extra " character, which is preserved literally and makes the check text noisy/ambiguous.

Suggested fix

- name: "Breaking Changes" mode: "error" instructions: | - "Fails if files under 'apis/**' or 'cmd/**' remove or rename public + Fails if files under 'apis/**' or 'cmd/**' remove or rename public fields/flags, add new required public fields/flags, or remove behavior without label 'breaking-change'.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

"Fails if files under 'apis/**' or 'cmd/**' remove or rename public

fields/flags, add new required public fields/flags, or remove behavior

without label 'breaking-change'.

- name: "Breaking Changes"

mode: "error"

instructions: |

Fails if files under 'apis/**' or 'cmd/**' remove or rename public

fields/flags, add new required public fields/flags, or remove behavior

without label 'breaking-change'.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.coderabbit.yaml around lines 170 - 173, Remove the stray leading double-quote at the start of the block scalar for the custom check description that begins with "Fails if files under 'apis/**' or 'cmd/**'..." so the text is a normal YAML block (no literal leading quote); locate the YAML value containing that sentence and delete the initial " character so the check instructions read cleanly without the preserved quote.

Reworks the validate package to address eight comments from the PR review pass. Renderer: polymorphic dispatch * render.Renderer is now an interface; textRenderer, jsonRenderer, and yamlRenderer each implement it as their own concrete type. Adding a new format means adding a Renderer and registering it in the renderers map — no switch on string. (review crossplane#3, crossplane#4) * OutputFormat.Render dispatches via the registry; the empty string defaults to text for safety of zero-value callers. * renderText handles all per-resource line emission inline; the per-error prefix selection is encapsulated in a private helper that does not pretend to handle the [✓] or "[!] could not find" cases. SchemaValidate: decomposed * Extracted validateResource as a per-resource helper. SchemaValidate's body is now a clean fan-out and the //nolint:gocognit suppression is gone. (review crossplane#2) Tests: tightened, idiomatic, end-to-end * TestSchemaValidate now asserts on the full []FieldValidationError per resource (Type + Field), with cmpopts.IgnoreFields hiding the Message and Value strings that drift across k8s validator versions. Dropped the bespoke containsAllErrorTypes "at least once" matcher. (review crossplane#7) * All tests that take a context now use t.Context() instead of context.Background(). (review crossplane#6) * render text tests no longer compare full output bytes against a string constant; they assert on line counts plus per-line substrings with a generated summary line. (review crossplane#5) * Dropped the validateAndRender helper on Cmd. The validation + rendering + error-shaping logic lives directly in Cmd.Run. cmd_test.go now drives the command end-to-end through kong.Parse + ctx.Run against real YAML fixtures, capturing stdout from a real kong.Context. To keep the e2e run offline, testdata/cache contains a stand-in crossplane image package.yaml and the tests pass a matching --crossplane-image. (review #1, crossplane#8) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Jonathan Ogilvie <jonathan.ogilvie@sumologic.com>

adamwg requested a review from a team as a code owner May 5, 2026 22:10

adamwg requested review from jbw976 and removed request for a team May 5, 2026 22:10

Add coderabbit config

f5eee84

Copy Crossplane's coderabbit config as a starting point and remove irrelevant parts. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

adamwg force-pushed the awg/config branch from 36c9148 to 338618c Compare May 5, 2026 22:11

jbw976 approved these changes May 6, 2026

View reviewed changes

tampakrap reviewed May 6, 2026

View reviewed changes

adamwg added 2 commits May 6, 2026 16:32

Add jcogilvie and tampakrap to CODEOWNERS

01d3a4b

This repository has additional maintainers beyond the @crossplane/crossplane-maintainers group. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

ci: Don't lint or push protobufs

40224e7

The protos in this repository are vendored from crossplane/crossplane, so no need to lint them or push them to the Buf schema registry. This avoids the need for a `BUF_TOKEN` secret in this repo. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>

adamwg force-pushed the awg/config branch from 338618c to 40224e7 Compare May 6, 2026 22:33

coderabbitai Bot reviewed May 6, 2026

View reviewed changes

adamwg merged commit d7a5edf into crossplane:main May 6, 2026
10 checks passed

adamwg deleted the awg/config branch May 6, 2026 22:48

Uh oh!

Conversation

adamwg commented May 5, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of your changes

Summary by CodeRabbit

Uh oh!

jbw976 left a comment

Choose a reason for hiding this comment

Uh oh!

jbw976 May 6, 2026

Choose a reason for hiding this comment

Uh oh!

adamwg May 6, 2026

Choose a reason for hiding this comment

Uh oh!

jbw976 May 6, 2026

Choose a reason for hiding this comment

Uh oh!

adamwg May 6, 2026

Choose a reason for hiding this comment

Uh oh!

tampakrap May 6, 2026

Choose a reason for hiding this comment

Uh oh!

jbw976 May 6, 2026

Choose a reason for hiding this comment

Uh oh!

adamwg May 6, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot May 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adamwg commented May 5, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 6, 2026 •

edited

Loading